home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / fgetln.0 < prev    next >
Text File  |  1996-09-02  |  2KB  |  50 lines
  1.  
  2. FGETLN(3)                  UNIX Programmer's Manual                  FGETLN(3)
  3.  
  4. NNAAMMEE
  5.      ffggeettllnn - get a line from a stream
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssttddiioo..hh>>
  9.  
  10.      _c_h_a_r _*
  11.      ffggeettllnn(_F_I_L_E _*_s_t_r_e_a_m, _s_i_z_e___t _*_l_e_n)
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.      The ffggeettllnn() function returns a pointer to the next line from the stream
  15.      referenced by _s_t_r_e_a_m. This line is _n_o_t a C string as it does not end with
  16.      a terminating NUL character.  The length of the line, including the final
  17.      newline, is stored in the memory location to which _l_e_n points.  (Note,
  18.      however, that if the line is the last in a file that does not end in a
  19.      newline, the returned text will not contain a newline.)
  20.  
  21. RREETTUURRNN VVAALLUUEESS
  22.      Upon successful completion a pointer is returned; this pointer becomes
  23.      invalid after the next I/O operation on _s_t_r_e_a_m (whether successful or
  24.      not) or as soon as the stream is closed.  Otherwise, NULL is returned.
  25.      The ffggeettllnn() function does not distinguish between end-of-file and error;
  26.      the routines feof(3) and ferror(3) must be used to determine which oc-
  27.      curred.  If an error occurs, the global variable _e_r_r_n_o is set to indicate
  28.      the error.  The end-of-file condition is remembered, even on a terminal,
  29.      and all subsequent attempts to read will return NULL until the condition
  30.      is cleared with clearerr(3).
  31.  
  32.      The text to which the returned pointer points may be modified, provided
  33.      that no changes are made beyond the returned size.  These changes are
  34.      lost as soon as the pointer becomes invalid.
  35.  
  36. EERRRROORRSS
  37.      [EBADF]  The argument _s_t_r_e_a_m is not a stream open for reading.
  38.  
  39.      The ffggeettllnn() function may also fail and set _e_r_r_n_o for any of the errors
  40.      specified for the routines fflush(3),  malloc(3),  read(2),  stat(2),  or
  41.      realloc(3).
  42.  
  43. SSEEEE AALLSSOO
  44.      ferror(3),  fgets(3),  fopen(3),  putc(3)
  45.  
  46. HHIISSTTOORRYY
  47.      The ffggeettllnn() function first appeared in 4.4BSD.
  48.  
  49. BSD Experimental                April 19, 1994                               1
  50.